Skip to content

Inscoper::ParentStatusParam

ParentStatusParam class is a specialized StatusParam that allows hierarchical relationships. More...

#include <ParentStatusParam.h>

Inherits from Inscoper::StatusParam

Inherited by Inscoper::ChildStatusParam, Inscoper::ModifiableStatusParam

Public Functions

Name
virtual unsigned int getModifierIndex()
Get modifiable parameter identifier.

Protected Functions

Name
ParentStatusParam(const ParentStatusParam & other)
Copy constructor.
ParentStatusParam(ParentStatusParam && other)
Move constructor.
ParentStatusParam & operator=(const ParentStatusParam & other) =delete
ParentStatusParam & operator=(ParentStatusParam && other) =delete
ParentStatusParam(const Inscoper::SubDeviceId & subDeviceId)
Constructor with sub-device ID.

Additional inherited members

Public Functions inherited from Inscoper::StatusParam

Name
StatusParam(const StatusParam & other)
Copy constructor.
StatusParam(StatusParam && other)
Move constructor.
StatusParam(const Inscoper::SubDeviceId & subDeviceId)
Constructor from sub-device ID.
StatusParam(const Inscoper::SubDeviceId & subDeviceId, const std::string & value)
Constructor from sub-device ID and string value.
StatusParam(const Inscoper::SubDeviceId & subDeviceId, unsigned char value)
Constructor from sub-device ID and unsigned char value.
StatusParam(const Inscoper::SubDeviceId & subDeviceId, char value)
Constructor from sub-device ID and char value.
StatusParam(const Inscoper::SubDeviceId & subDeviceId, unsigned short value)
Constructor from sub-device ID and unsigned short value.
StatusParam(const Inscoper::SubDeviceId & subDeviceId, short value)
Constructor from sub-device ID and short value.
StatusParam(const Inscoper::SubDeviceId & subDeviceId, unsigned int value)
Constructor from sub-device ID and unsigned int value.
StatusParam(const Inscoper::SubDeviceId & subDeviceId, int value)
Constructor from sub-device ID and int value.
StatusParam(const Inscoper::SubDeviceId & subDeviceId, unsigned long long int value)
Constructor from sub-device ID and unsigned long long value.
StatusParam(const Inscoper::SubDeviceId & subDeviceId, long long int value)
Constructor from sub-device ID and long long value.
StatusParam(const Inscoper::SubDeviceId & subDeviceId, float value)
Constructor from sub-device ID and float value.
StatusParam(const Inscoper::SubDeviceId & subDeviceId, double value)
Constructor from sub-device ID and double value.
StatusParam(const Inscoper::SubDeviceId & subDeviceId, bool value)
Constructor from sub-device ID and boolean value.
StatusParam(const Inscoper::SubDeviceId & subDeviceId, const char * value)
Constructor from sub-device ID and C-string value.
~StatusParam()
Destructor.
const Inscoper::SubDeviceId getSubDeviceId() const
Get sub-device ID.
void setSubDeviceId(const Inscoper::SubDeviceId & subDeviceId)
Set sub-device ID.
bool hasValue()
Check if the status parameter has a value.
std::string getStringValue()
Get value as string.
unsigned char getUnsignedCharValue()
Get value as unsigned char.
char getCharValue()
Get value as char.
unsigned short getUnsignedShortValue()
Get value as unsigned short.
short getShortValue()
Get value as short.
unsigned int getUnsignedIntValue()
Get value as unsigned int.
int getIntValue()
Get value as int.
unsigned long long int getUnsignedLongValue()
Get value as unsigned long long.
long long int getLongValue()
Get value as long long.
float getFloatValue()
Get value as float.
double getDoubleValue()
Get value as double.
void setValue(const std::string & value)
Set value from string.
void setValue(unsigned char value)
Set value from unsigned char.
void setValue(char value)
Set value from char.
void setValue(unsigned short value)
Set value from unsigned short.
void setValue(short value)
Set value from short.
void setValue(unsigned int value)
Set value from unsigned int.
void setValue(int value)
Set value from int.
void setValue(unsigned long long int value)
Set value from unsigned long long.
void setValue(long long int value)
Set value from long long.
void setValue(float value)
Set value from float.
void setValue(double value)
Set value from double.
void setValue(bool value)
Set value from bool.
void setValue(const char * value)
Set value from C-string.
void addValue(unsigned short tag, const std::string & value)
Add a string value for a specific parameter index.
void addValue(unsigned short tag, unsigned char value)
Add a tagged unsigned char value for a specific parameter index.
void addValue(unsigned short tag, char value)
Add a tagged char value for a specific parameter index.
void addValue(unsigned short tag, unsigned short value)
Add a tagged unsigned short value for a specific parameter index.
void addValue(unsigned short tag, short value)
Add a tagged short value for a specific parameter index.
void addValue(unsigned short tag, unsigned int value)
Add a tagged unsigned int value for a specific parameter index.
void addValue(unsigned short tag, int value)
Add a tagged int value for a specific parameter index.
void addValue(unsigned short tag, unsigned long long int value)
Add a tagged unsigned long long value for a specific parameter index.
void addValue(unsigned short tag, long long int value)
Add a tagged long long value for a specific parameter index.
void addValue(unsigned short tag, float value)
Add a tagged float value for a specific parameter index.
void addValue(unsigned short tag, double value)
Add a tagged double value for a specific parameter index.
void addValue(unsigned short tag, bool value)
Add a tagged boolean value for a specific parameter index.
void addValue(unsigned short tag, const char * value)
Add a tagged C-string value for a specific parameter index.
void addValue(unsigned short index, unsigned short tag, const std::string & value)
Add a string value associated with a specific parameter index and value index.
void addValue(unsigned short index, unsigned short tag, unsigned char value)
Add an unsigned char value associated with a specific parameter index and value index.
void addValue(unsigned short index, unsigned short tag, char value)
Add a char value associated with a specific parameter index and value index.
void addValue(unsigned short index, unsigned short tag, unsigned short value)
Add an unsigned short value associated with a specific parameter index and value index.
void addValue(unsigned short index, unsigned short tag, short value)
Add a short value associated with a specific parameter index and value index.
void addValue(unsigned short index, unsigned short tag, unsigned int value)
Add an unsigned int value associated with a specific parameter index and value index.
void addValue(unsigned short index, unsigned short tag, int value)
Add an int value associated with a specific parameter index and value index.
void addValue(unsigned short index, unsigned short tag, unsigned long long int value)
Add an unsigned long long value associated with a specific parameter index and value index.
void addValue(unsigned short index, unsigned short tag, long long int value)
Add a long long value associated with a specific parameter index and value index.
void addValue(unsigned short index, unsigned short tag, float value)
Add a float value associated with a specific parameter index and value index.
void addValue(unsigned short index, unsigned short tag, double value)
Add a double value associated with a specific parameter index and value index.
void addValue(unsigned short index, unsigned short tag, bool value)
Add a bool value associated with a specific parameter index and value index.
void addValue(unsigned short index, unsigned short tag, const char * value)
Add a C-string value associated with a specific parameter index and value index.
virtual std::string getType()
Get type as string (deprecated).
virtual std::string print()
Get string representation.
Inscoper::EParamType getValueType()
Get value type.
virtual std::shared_ptr< StatusParam > clone()
Clone object.
virtual bool equals(const std::shared_ptr< StatusParam > & other)
Check equality.
virtual std::shared_ptr< Core::InternalStatusParam > getInternal()
Get internal object.

Protected Attributes inherited from Inscoper::StatusParam

Name
std::shared_ptr< Core::InternalStatusParam > _internal

Detailed Description

class Inscoper::ParentStatusParam;

ParentStatusParam class is a specialized StatusParam that allows hierarchical relationships.

This class extends StatusParam to support hierarchical relationships.

Public Functions Documentation

function getModifierIndex

virtual unsigned int getModifierIndex()

Get modifiable parameter identifier.

Return: The modifiable parameter identifier

Retrieves the identifier for the modifiable parameter attached to it.

Protected Functions Documentation

function ParentStatusParam

ParentStatusParam(
    const ParentStatusParam & other
)

Copy constructor.

Parameters:

function ParentStatusParam

ParentStatusParam(
    ParentStatusParam && other
)

Move constructor.

Parameters:

function operator=

ParentStatusParam & operator=(
    const ParentStatusParam & other
) =delete

function operator=

ParentStatusParam & operator=(
    ParentStatusParam && other
) =delete

function ParentStatusParam

explicit ParentStatusParam(
    const Inscoper::SubDeviceId & subDeviceId
)

Constructor with sub-device ID.

Parameters:

  • subDeviceId : The sub-device ID of the associated sub-device

Updated on 2026-04-02 at 10:55:36 +0200